Skip to main content

FlowDocumentSynchronizer Properties

An object defining properties for the FlowDocumentSynchronizer class.

TargetType

Defines the type of the target in the synchronization process.

Type: DocumentSynchronizerTargetType
Accepted Values:

NameValue
Document0
TableOnTheDocument1
DetailsOnTheDocument2
TableOnTheDatabase3
ExecuteIntegrationQuery4
DetailsGridOnTheDocument5

TargetTableName

The name of the table in the target document.

Type: string


Key

A unique identifier for the workflow step.

Type: string


TargetConnectionName

The name of the connection for the target document.

Type: string


Fields

Represents a list of fields used for mapping between source and target documents.

Type: List<FlowMatchingOptionsField>


WorkflowCodeInstance

The workflow code instance associated with the flow object.

Type: IWorkflowCode


CachedDMObjects

The cached document management objects related to the flow object.

Type: IRuntimeDMObjects


HideSystemFields

Determines whether system fields are hidden during synchronization.

Type: bool


TypeCode

The type code associated with the flow object.

Type: WorkflowItemTypeCode
Accepted Values:

NameValue
FlowComment-1
FlowStart10
FlowEnd11
FlowPosition15
FlowAssign21
FlowCompare22
FlowOr24
FlowAnd25
FlowMail26
FlowProfession27
FlowDepartment28
Variable30
FlowScript31
FlowNode33
FlowGroup37
FlowTimer39
FlowTimerStarter40
FlowTimerStopper41
FlowApprovalCancellar42
Pauser44
SubFlowCall51
SubFlowBegin52
SubFlowEnd53
FlowPushNotification54
FlowDocument56
FlowCreateDocument57
FlowDocumentSynchronizer58
FlowStarterPosition59
FlowDocumentState63
FlowUniqueIdCreator65
FlowSetDocumentId66
FlowDeleteDocument67
FlowPDFExport68
FlowXMLExport69
FlowMailSender75
FlowParallel79
FlowContinue80
FlowTrigger81
FlowActionCreator82
FlowDigitallySigning83
FlowGptPrompt84

ValueType

Indicates the type of the value being synchronized.

Type: int?


ValueSourceType

Indicates the source type of the value in the synchronization process.

Type: int


ResumeOnError

Indicates whether the synchronization process should continue when an error occurs. (Deprecated)

Type: bool


ErrorDescriptionObjectName

Specifies the object name for error descriptions during synchronization. (Deprecated)

Type: string


ErrorOptions

Defines error-related options for the API step.

Type: IFlowErrorOptions


Name

Name for the workflow step.

Type: string


Value

The actual value being synchronized between source and target.

Type: object


SourceDocumentObjectName

The object name of the source document for synchronization.

Type: string


SourceType

Defines the type of the source in the synchronization process.

Type: DocumentSynchronizerSourceType
Accepted Values:

NameValue
Document0
TableOnTheDocument1
DetailsOnTheDocument2
DetailsGridOnTheDocument3

TargetQueryName

The name of the query used for the target document.

Type: string


SourceDetailName

The detail name associated with the source document.

Type: string


TargetDocumentObjectName

The object name of the target document for synchronization.

Type: string


TargetDetail

The detail associated with the target document.

Type: string


Caption

The caption dictionary representing localized captions for the flow object.

Type: Dictionary<string, string>